Use these endpoints to review your team's Apollo API usage, including endpoint rate limits and credit balances. You can use this information to pace API requests and monitor credit consumption in your own system.
Key concepts
| Request usage and rate limits | Request usage tracks calls to Apollo API. Rate limits control how many requests your team can make to an endpoint per minute, hour, and day. The limits available to your team depend on your Apollo plan. |
| Credit usage and balances | Credits fund certain Apollo actions. Credit usage stats return the allowance, amount consumed, and remaining balance for each credit type. Credit balances and request rate limits are separate: an endpoint can have a rate limit even when it doesn't consume credits. |
| Credit cycle | Credit balances cover your team's current billing cycle. The current_credit_cycle object identifies the start and end dates. Use those dates when comparing usage over time. |
Choose an endpoint
| I want to . . . | Use this |
|---|---|
| Review my team's request usage and endpoint rate limits | View API usage stats and rate limits |
| Review my team's credit allowance, consumption, and remaining balances | View credit usage stats |
Example workflows
Plan and monitor an enrichment run
Check request limits and credit availability before processing enrichment requests, then monitor usage as the run progresses.
- Call view API usage stats and rate limits to retrieve your team's usage and limits for the enrichment endpoint you plan to use.
- Call view credit usage stats. Review
limit,consumed, andleft_overfor the relevant credit types, and retain the dates incurrent_credit_cycle. - Process your enrichment requests at a pace that respects the endpoint's minute, hour, and day limits. Use the enrichment endpoint's credit requirements to determine which data to request.
- Retrieve usage stats and credit balances again as needed to monitor the run and adjust the remaining work.
On unified credit plans, lead_credit represents a shared pool. Its remaining balance already accounts for other actions that draw from that pool, so don't add the individual balances together.
Learn more: Use the view API usage stats and rate limits and view credit usage stats references to dig in to the workflow.